/*
 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.sun.max.tele.object;

import com.sun.max.tele.*;
import com.sun.max.tele.reference.*;
import com.sun.max.unsafe.*;
import com.sun.max.vm.heap.gcx.*;


/**
 * @see HeapFreeChunk
 */
public class TeleHeapFreeChunk extends TeleTupleObject {

    private Size size = Size.zero();
    private RemoteReference nextRef = referenceManager().zeroReference();

    public TeleHeapFreeChunk(TeleVM vm, RemoteReference heapFreeChunkReference) {
        super(vm, heapFreeChunkReference);
    }

    @Override
    protected boolean updateObjectCache(long epoch, StatsPrinter statsPrinter) {
        if (!super.updateObjectCache(epoch, statsPrinter)) {
            return false;
        }
        size = fields().HeapFreeChunk_size.readWord(reference()).asSize();
        nextRef = fields().HeapFreeChunk_next.readRemoteReference(reference());
        return true;
    }

    /**
     * Gets the size of the free space represented by this quasi-object, including the legitimate paerts
     * of the object:  header and fields.
     *
     * @return the total size of the free space occupied by the quasi-object
     */
    public final Size size() {
        return size;
    }

    /**
     * @return reference to the next linked instance in a free list
     */
    public final RemoteReference nextRef() {
        return nextRef;
    }

}
